Repository navigation
docs: fix two broken examples in transports.md - #3774
Open
Aiudadadadf wants to merge 1 commit into
Open
Aiudadadadf wants to merge 1 commit into
Aiudadadadf wants to merge 1 commit into
Conversation
OKAN-SOFTWARE
left a comment
OKAN-SOFTWARE
left a comment
There was a problem hiding this comment.
I noticed a Markdown formatting regression in the updated mounts example.
The closing code fence (```) was removed after the httpx.Client(mounts={...}) block.
As a result, the following paragraph beginning with “A useful pattern here is custom transport classes...” is rendered inside the Python code block instead of as normal documentation text.
Could we restore the closing triple-backtick immediately after })?
This should preserve the intended Markdown structure while keeping the corrected transport example.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found two broken examples in
docs/advanced/transports.mdthat would confuse anyone trying to run them.The first is in the "Custom transports" section. It references
httpx.Mounts()as a class, which doesn't exist - the correct way to use mounts is passing a dict toClient(mounts=...). The example also had a missing comma between dict entries, and then passed the result in astransport=transportinstead ofmounts=mounts. Fixed it to useClient(mounts={...})inline so there's no ambiguity.The second is in the "Mounting transports" section. The
HTTPSRedirectTransportclass hadhandle_request(self, method, url, headers, stream, extensions)returning a tuple(303, headers, stream, extensions)- that's the old low-level transport API from a previous major version. The currentBaseTransport.handle_requesttakes a singleRequestobject and returns aResponse. Rewrote it to match, usingrequest.url.copy_with(scheme="https")andhttpx.Response(303, ...)the same way the nearbyHTTPSRedirectexample already does it correctly.